<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FLAC: FLAC/stream_encoder.h: stream encoder interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">FLAC
   &#160;<span id="projectnumber">1.4.3</span>
   </div>
   <div id="projectbrief">Free Lossless Audio Codec</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#enumval-members">Enumerator</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">FLAC/stream_encoder.h: stream encoder interface<div class="ingroups"><a class="el" href="group__flac.html">FLAC C API</a> &raquo; <a class="el" href="group__flac__encoder.html">FLAC/ *_encoder.h: encoder interfaces</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga18b7941b93bae067192732e913536d44"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga18b7941b93bae067192732e913536d44">FLAC__StreamEncoderReadCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data)</td></tr>
<tr class="separator:ga18b7941b93bae067192732e913536d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2998a0af774d793928a7cc3bbc84dcdf"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data)</td></tr>
<tr class="separator:ga2998a0af774d793928a7cc3bbc84dcdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70b85349d5242e4401c4d8ddf6d9bbca"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td></tr>
<tr class="separator:ga70b85349d5242e4401c4d8ddf6d9bbca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabefdf2279e1d0347d9f98f46da4e415b"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td></tr>
<tr class="separator:gabefdf2279e1d0347d9f98f46da4e415b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga091fbf3340d85bcbda1090c31bc320cf"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td></tr>
<tr class="separator:ga091fbf3340d85bcbda1090c31bc320cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42a5fab5f91c1b0c3f7098499285f277"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data)</td></tr>
<tr class="separator:ga42a5fab5f91c1b0c3f7098499285f277"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gac5e9db4fc32ca2fa74abd9c8a87c02a5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a> { <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6">FLAC__STREAM_ENCODER_OK</a> = 0
, <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a04912e04a3c57d3c53de34742f96d635">FLAC__STREAM_ENCODER_UNINITIALIZED</a>
, <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5abb312cc8318c7a541cadacd23ceb3bbb">FLAC__STREAM_ENCODER_OGG_ERROR</a>
, <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a4cb80be4f83eb71f04e74968af1d259e">FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</a>
, <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a011e3d8b2d02a940bfd0e59c05cf5ae0">FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA</a>
, <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a8c2b2e9efb43a4f9b25b1d2bd9af5f23">FLAC__STREAM_ENCODER_CLIENT_ERROR</a>
, <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5af0e4738522e05a7248435c7148f58f91">FLAC__STREAM_ENCODER_IO_ERROR</a>
, <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a2c2937b7f1600a4ac7c84fc70ab34cf1">FLAC__STREAM_ENCODER_FRAMING_ERROR</a>
, <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a35db99d9958bd6c2301a04715fbc44fd">FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR</a>
<br />
 }</td></tr>
<tr class="separator:gac5e9db4fc32ca2fa74abd9c8a87c02a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3bb869620af2b188d77982a5c30b047d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> { <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da20501dce552da74c5df935eeaa0c9ee3">FLAC__STREAM_ENCODER_INIT_STATUS_OK</a> = 0
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da9c64e5f9020d8799e1cd9d39d50e6955">FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da8a822b011de88b67c114505ffef39327">FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047dac2cf461f02e20513003b8cadeae03f9f">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS</a>
, <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da0541c4f827f081b9f1c54c9441e4aa65">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047dad6d2631f464183c0c165155200882e6b">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da6fdcde9e18c37450c79e8f12b9d9c134">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da652c445f1bd8b6cfb963a30bf416c95a">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE</a>
, <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da38a69e94b3333e4ba779d2ff8f43f64e">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da5be80403bd7a43450139442e0f34ad7e">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da62a17a3ed3c05ddf8ea7f6fecbd4e4a1">FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047daa793405c858c7606539082750080a47e">FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE</a>
, <br />
&#160;&#160;<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047daa85afdd1849c75a19594416cef63e3e9">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA</a>
, <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047dab4e7b50d176a127575df90383cb15e1d">FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED</a>
<br />
 }</td></tr>
<tr class="separator:ga3bb869620af2b188d77982a5c30b047d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e81f007fb0a7414c0bbb453f37ea37f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a> { <a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e">FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE</a>
, <a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee">FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM</a>
, <a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_READ_STATUS_ABORT</a>
, <a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa9bb730b8f6354cc1e810017a2f700316">FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED</a>
 }</td></tr>
<tr class="separator:ga2e81f007fb0a7414c0bbb453f37ea37f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3737471fd49730bb8cf9b182bdeda05e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a> { <a class="el" href="group__flac__stream__encoder.html#gga3737471fd49730bb8cf9b182bdeda05ea5622e0199f0203c402fcb7b4ca76f808">FLAC__STREAM_ENCODER_WRITE_STATUS_OK</a> = 0
, <a class="el" href="group__flac__stream__encoder.html#gga3737471fd49730bb8cf9b182bdeda05ea18e7cd6a443fb8bd303c3ba89946bc85">FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR</a>
 }</td></tr>
<tr class="separator:ga3737471fd49730bb8cf9b182bdeda05e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d5be3489f45fcf0c252022c65d87aca"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a> { <a class="el" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667">FLAC__STREAM_ENCODER_SEEK_STATUS_OK</a>
, <a class="el" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60">FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR</a>
, <a class="el" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037">FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</a>
 }</td></tr>
<tr class="separator:ga6d5be3489f45fcf0c252022c65d87aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab628f63181250eb977a28bf12b7dd9ff"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a> { <a class="el" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b">FLAC__STREAM_ENCODER_TELL_STATUS_OK</a>
, <a class="el" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b">FLAC__STREAM_ENCODER_TELL_STATUS_ERROR</a>
, <a class="el" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7">FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</a>
 }</td></tr>
<tr class="separator:gab628f63181250eb977a28bf12b7dd9ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab09f7620a0ba9c30020c189ce112a52f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new</a> (void)</td></tr>
<tr class="separator:gab09f7620a0ba9c30020c189ce112a52f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7212e6846f543618b6289666de216b29"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga7212e6846f543618b6289666de216b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf4f75f7689b6b3fff16b03028aa38326"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaf4f75f7689b6b3fff16b03028aa38326">FLAC__stream_encoder_set_ogg_serial_number</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, long serial_number)</td></tr>
<tr class="separator:gaf4f75f7689b6b3fff16b03028aa38326"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga795be6527a9eb1219331afef2f182a41"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga795be6527a9eb1219331afef2f182a41">FLAC__stream_encoder_set_verify</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga795be6527a9eb1219331afef2f182a41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35a18815a58141b88db02317892d059b"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga35a18815a58141b88db02317892d059b">FLAC__stream_encoder_set_streamable_subset</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga35a18815a58141b88db02317892d059b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ec612a48f81805eafdb059548cdaf92"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9ec612a48f81805eafdb059548cdaf92">FLAC__stream_encoder_set_channels</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga9ec612a48f81805eafdb059548cdaf92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7453fc29d7e86b499f23b1adfba98da1"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga7453fc29d7e86b499f23b1adfba98da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa6b6537875900a6e0f4418a504f55f25"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaa6b6537875900a6e0f4418a504f55f25">FLAC__stream_encoder_set_sample_rate</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gaa6b6537875900a6e0f4418a504f55f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaacc01aab02849119f929b8516420fcd3"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaacc01aab02849119f929b8516420fcd3">FLAC__stream_encoder_set_compression_level</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gaacc01aab02849119f929b8516420fcd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac35cb1b5614464658262e684c4ac3a2f"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gac35cb1b5614464658262e684c4ac3a2f">FLAC__stream_encoder_set_blocksize</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gac35cb1b5614464658262e684c4ac3a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3bff001a1efc2e4eb520c954066330f4"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3bff001a1efc2e4eb520c954066330f4">FLAC__stream_encoder_set_do_mid_side_stereo</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga3bff001a1efc2e4eb520c954066330f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7965d51b93f14cbd6ad5bb9d34f10536"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7965d51b93f14cbd6ad5bb9d34f10536">FLAC__stream_encoder_set_loose_mid_side_stereo</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga7965d51b93f14cbd6ad5bb9d34f10536"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6598f09ac782a1f2a5743ddf247c81c8"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6598f09ac782a1f2a5743ddf247c81c8">FLAC__stream_encoder_set_apodization</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const char *specification)</td></tr>
<tr class="separator:ga6598f09ac782a1f2a5743ddf247c81c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad8a0ff058c46f9ce95dc0508f4bdfb0c"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gad8a0ff058c46f9ce95dc0508f4bdfb0c">FLAC__stream_encoder_set_max_lpc_order</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gad8a0ff058c46f9ce95dc0508f4bdfb0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga179751f915a3d6fc2ca4b33a67bb8780"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga179751f915a3d6fc2ca4b33a67bb8780">FLAC__stream_encoder_set_qlp_coeff_precision</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga179751f915a3d6fc2ca4b33a67bb8780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga495890067203958e5d67a641f8757b1c"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga495890067203958e5d67a641f8757b1c">FLAC__stream_encoder_set_do_qlp_coeff_prec_search</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga495890067203958e5d67a641f8757b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed594c373d829f77808a935c54a25fa4"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaed594c373d829f77808a935c54a25fa4">FLAC__stream_encoder_set_do_escape_coding</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:gaed594c373d829f77808a935c54a25fa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga054313e7f6eaf5c6122d82c6a8b3b808"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga054313e7f6eaf5c6122d82c6a8b3b808">FLAC__stream_encoder_set_do_exhaustive_model_search</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga054313e7f6eaf5c6122d82c6a8b3b808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f2ed5a2b35bfea13e6605b0fe55f0fa"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga8f2ed5a2b35bfea13e6605b0fe55f0fa">FLAC__stream_encoder_set_min_residual_partition_order</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga8f2ed5a2b35bfea13e6605b0fe55f0fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9e02bfbbb1d4fcdb666e2e9a678b4f6"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab9e02bfbbb1d4fcdb666e2e9a678b4f6">FLAC__stream_encoder_set_max_residual_partition_order</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gab9e02bfbbb1d4fcdb666e2e9a678b4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2cc4a05caba8a4058f744d9eb8732caa"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga2cc4a05caba8a4058f744d9eb8732caa">FLAC__stream_encoder_set_rice_parameter_search_dist</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga2cc4a05caba8a4058f744d9eb8732caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab943094585d1c0a4bec497e73567cf85"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 value)</td></tr>
<tr class="separator:gab943094585d1c0a4bec497e73567cf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga80d57f9069e354cbf1a15a3e3ad9ca78"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga80d57f9069e354cbf1a15a3e3ad9ca78">FLAC__stream_encoder_set_metadata</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, uint32_t num_blocks)</td></tr>
<tr class="separator:ga80d57f9069e354cbf1a15a3e3ad9ca78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac8c5f361b441d528b7a6791b66bb9d40"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gac8c5f361b441d528b7a6791b66bb9d40">FLAC__stream_encoder_set_limit_min_bitrate</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:gac8c5f361b441d528b7a6791b66bb9d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0803321b37189dc5eea4fe1cea25c29a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga0803321b37189dc5eea4fe1cea25c29a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga820704b95a711e77d55363e8753f9f9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#ga3adb6891c5871a87cd5bbae6c770ba2d">FLAC__StreamDecoderState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga820704b95a711e77d55363e8753f9f9f">FLAC__stream_encoder_get_verify_decoder_state</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga820704b95a711e77d55363e8753f9f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0916f813358eb6f1e44148353acd4d42"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0916f813358eb6f1e44148353acd4d42">FLAC__stream_encoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga0916f813358eb6f1e44148353acd4d42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28373aaf2c47336828d5672696c36662"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga28373aaf2c47336828d5672696c36662">FLAC__stream_encoder_get_verify_decoder_error_stats</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_sample, uint32_t *frame_number, uint32_t *channel, uint32_t *sample, FLAC__int32 *expected, FLAC__int32 *got)</td></tr>
<tr class="separator:ga28373aaf2c47336828d5672696c36662"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9efc4964992e001bcec0a8eaedee8d60"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9efc4964992e001bcec0a8eaedee8d60">FLAC__stream_encoder_get_verify</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga9efc4964992e001bcec0a8eaedee8d60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga201e64032ea4298b2379c93652b28245"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga201e64032ea4298b2379c93652b28245">FLAC__stream_encoder_get_streamable_subset</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga201e64032ea4298b2379c93652b28245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga412401503141dd42e37831140f78cfa1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga412401503141dd42e37831140f78cfa1">FLAC__stream_encoder_get_channels</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga412401503141dd42e37831140f78cfa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga169bbf662b2a2df017b93f663deadd1d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga169bbf662b2a2df017b93f663deadd1d">FLAC__stream_encoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga169bbf662b2a2df017b93f663deadd1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae56f27536528f13375ffdd23fa9045f7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gae56f27536528f13375ffdd23fa9045f7">FLAC__stream_encoder_get_sample_rate</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gae56f27536528f13375ffdd23fa9045f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8a9715b2d09a6876b8dc104bfd70cdc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaf8a9715b2d09a6876b8dc104bfd70cdc">FLAC__stream_encoder_get_blocksize</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gaf8a9715b2d09a6876b8dc104bfd70cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga32da1f89997ab94ce5d677fcd7e24d56"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga32da1f89997ab94ce5d677fcd7e24d56">FLAC__stream_encoder_get_do_mid_side_stereo</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga32da1f89997ab94ce5d677fcd7e24d56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1455859cf3d233bd4dfff86af010f4fa"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga1455859cf3d233bd4dfff86af010f4fa">FLAC__stream_encoder_get_loose_mid_side_stereo</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga1455859cf3d233bd4dfff86af010f4fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e1d1c9acd3d5a17106b51f0c0107567"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga5e1d1c9acd3d5a17106b51f0c0107567">FLAC__stream_encoder_get_max_lpc_order</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga5e1d1c9acd3d5a17106b51f0c0107567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga909830fb7f4a0a35710452df39c269a3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga909830fb7f4a0a35710452df39c269a3">FLAC__stream_encoder_get_qlp_coeff_precision</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga909830fb7f4a0a35710452df39c269a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65bee5a769d4c5fdc95b81c2fb95061c"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga65bee5a769d4c5fdc95b81c2fb95061c">FLAC__stream_encoder_get_do_qlp_coeff_prec_search</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga65bee5a769d4c5fdc95b81c2fb95061c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c944049800991422c1bfb3b1c0567a5"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0c944049800991422c1bfb3b1c0567a5">FLAC__stream_encoder_get_do_escape_coding</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga0c944049800991422c1bfb3b1c0567a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7bc8b32f58df5564db4b6114cb11042d"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7bc8b32f58df5564db4b6114cb11042d">FLAC__stream_encoder_get_do_exhaustive_model_search</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga7bc8b32f58df5564db4b6114cb11042d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4fa722297092aeaebc9d9e743a327d14"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga4fa722297092aeaebc9d9e743a327d14">FLAC__stream_encoder_get_min_residual_partition_order</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga4fa722297092aeaebc9d9e743a327d14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f5dfbfb5c6e569c4bae5555c9bf87e6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6f5dfbfb5c6e569c4bae5555c9bf87e6">FLAC__stream_encoder_get_max_residual_partition_order</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga6f5dfbfb5c6e569c4bae5555c9bf87e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca0e38f283b2772b92da7cb4495d909a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaca0e38f283b2772b92da7cb4495d909a">FLAC__stream_encoder_get_rice_parameter_search_dist</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gaca0e38f283b2772b92da7cb4495d909a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa22d8935bd985b9cccf6592160ffc6f2"><td class="memItemLeft" align="right" valign="top">FLAC__uint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaa22d8935bd985b9cccf6592160ffc6f2">FLAC__stream_encoder_get_total_samples_estimate</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gaa22d8935bd985b9cccf6592160ffc6f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga741c26084d203ac24d16c875b5d902ac"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga741c26084d203ac24d16c875b5d902ac">FLAC__stream_encoder_get_limit_min_bitrate</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga741c26084d203ac24d16c875b5d902ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7d801879812b48fcbc40f409800c453c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, <a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a> seek_callback, <a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a> tell_callback, <a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a> metadata_callback, void *client_data)</td></tr>
<tr class="separator:ga7d801879812b48fcbc40f409800c453c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d1981bcd30b8db4d73b5466be5570f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, <a class="el" href="group__flac__stream__encoder.html#ga18b7941b93bae067192732e913536d44">FLAC__StreamEncoderReadCallback</a> read_callback, <a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a> seek_callback, <a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a> tell_callback, <a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a> metadata_callback, void *client_data)</td></tr>
<tr class="separator:ga9d1981bcd30b8db4d73b5466be5570f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12789a1c4a4e31cd2e7187259fe127f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FILE *file, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga12789a1c4a4e31cd2e7187259fe127f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57fc668f50ffd99a93df326bfab5e2b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga57fc668f50ffd99a93df326bfab5e2b1">FLAC__stream_encoder_init_ogg_FILE</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FILE *file, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga57fc668f50ffd99a93df326bfab5e2b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d5117c2ac0eeb572784116bf2eb541b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const char *filename, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga9d5117c2ac0eeb572784116bf2eb541b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4891de2f56045941ae222b61b0fd83a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga4891de2f56045941ae222b61b0fd83a4">FLAC__stream_encoder_init_ogg_file</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const char *filename, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga4891de2f56045941ae222b61b0fd83a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3522f9de5af29807df1b9780a418b7f3"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga3522f9de5af29807df1b9780a418b7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87b9c361292da5c5928a8fb5fda7c423"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__int32 *const buffer[], uint32_t samples)</td></tr>
<tr class="separator:ga87b9c361292da5c5928a8fb5fda7c423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e31c221f7e23345267c52f53c046c24"><td class="memItemLeft" align="right" valign="top">FLAC__bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__int32 buffer[], uint32_t samples)</td></tr>
<tr class="separator:ga6e31c221f7e23345267c52f53c046c24"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga1410b7a076b0c8401682f9f812b66df5"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga1410b7a076b0c8401682f9f812b66df5">FLAC__StreamEncoderStateString</a> []</td></tr>
<tr class="separator:ga1410b7a076b0c8401682f9f812b66df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ec1fa7b3f55b4f07a2727846c285776"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0ec1fa7b3f55b4f07a2727846c285776">FLAC__StreamEncoderInitStatusString</a> []</td></tr>
<tr class="separator:ga0ec1fa7b3f55b4f07a2727846c285776"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1654422c81846b9b399ac5fb98df61dd"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga1654422c81846b9b399ac5fb98df61dd">FLAC__StreamEncoderReadStatusString</a> []</td></tr>
<tr class="separator:ga1654422c81846b9b399ac5fb98df61dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f64480accd01525cbfa25c11e6bb74e"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9f64480accd01525cbfa25c11e6bb74e">FLAC__StreamEncoderWriteStatusString</a> []</td></tr>
<tr class="separator:ga9f64480accd01525cbfa25c11e6bb74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabb137b2d787756bf97398f0b60e54c20"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gabb137b2d787756bf97398f0b60e54c20">FLAC__StreamEncoderSeekStatusString</a> []</td></tr>
<tr class="separator:gabb137b2d787756bf97398f0b60e54c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8ab921ae968be2be255be1f136e1eec"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaf8ab921ae968be2be255be1f136e1eec">FLAC__StreamEncoderTellStatusString</a> []</td></tr>
<tr class="separator:gaf8ab921ae968be2be255be1f136e1eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2820d2ad5c6395289b2abc7dc7399f76"><td class="memItemLeft" align="right" valign="top"><a id="ga2820d2ad5c6395289b2abc7dc7399f76"></a>
struct FLAC__StreamEncoderProtected *&#160;</td><td class="memItemRight" valign="bottom"><b>FLAC__StreamEncoder::protected_</b></td></tr>
<tr class="separator:ga2820d2ad5c6395289b2abc7dc7399f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6cc84bcaa3049936b459f5f2362b9076"><td class="memItemLeft" align="right" valign="top"><a id="ga6cc84bcaa3049936b459f5f2362b9076"></a>
struct FLAC__StreamEncoderPrivate *&#160;</td><td class="memItemRight" valign="bottom"><b>FLAC__StreamEncoder::private_</b></td></tr>
<tr class="separator:ga6cc84bcaa3049936b459f5f2362b9076"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module contains the functions which implement the stream encoder. </p>
<p>The stream encoder can encode to native FLAC, and optionally Ogg FLAC (check FLAC_API_SUPPORTS_OGG_FLAC) streams and files.</p>
<p>The basic usage of this encoder is as follows:</p><ul>
<li>The program creates an instance of an encoder using <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a>.</li>
<li>The program overrides the default settings using FLAC__stream_encoder_set_*() functions. At a minimum, the following functions should be called:<ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga9ec612a48f81805eafdb059548cdaf92">FLAC__stream_encoder_set_channels()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gaa6b6537875900a6e0f4418a504f55f25">FLAC__stream_encoder_set_sample_rate()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gaf4f75f7689b6b3fff16b03028aa38326">FLAC__stream_encoder_set_ogg_serial_number()</a> (if encoding to Ogg FLAC)</li>
<li><a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate()</a> (if known)</li>
</ul>
</li>
<li>If the application wants to control the compression level or set its own metadata, then the following should also be called:<ul>
<li><a class="el" href="group__flac__stream__encoder.html#gaacc01aab02849119f929b8516420fcd3">FLAC__stream_encoder_set_compression_level()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga795be6527a9eb1219331afef2f182a41">FLAC__stream_encoder_set_verify()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga80d57f9069e354cbf1a15a3e3ad9ca78">FLAC__stream_encoder_set_metadata()</a></li>
</ul>
</li>
<li>The rest of the set functions should only be called if the client needs exact control over how the audio is compressed; thorough understanding of the FLAC format is necessary to achieve good results.</li>
<li>The program initializes the instance to validate the settings and prepare for encoding using<ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a> or <a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE()</a> or <a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file()</a> for native FLAC</li>
<li><a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> or <a class="el" href="group__flac__stream__encoder.html#ga57fc668f50ffd99a93df326bfab5e2b1">FLAC__stream_encoder_init_ogg_FILE()</a> or <a class="el" href="group__flac__stream__encoder.html#ga4891de2f56045941ae222b61b0fd83a4">FLAC__stream_encoder_init_ogg_file()</a> for Ogg FLAC</li>
</ul>
</li>
<li>The program calls <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a> to encode data, which subsequently calls the callbacks when there is encoder data ready to be written.</li>
<li>The program finishes the encoding with <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>, which causes the encoder to encode any data still in its input pipe, update the metadata with the final encoding statistics if output seeking is possible, and finally reset the encoder to the uninitialized state.</li>
<li>The instance may be used again or deleted with <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a>.</li>
</ul>
<p>In more detail, the stream encoder functions similarly to the <a class="el" href="group__flac__stream__decoder.html">stream decoder </a>, but has fewer callbacks and more options. Typically the client will create a new instance by calling <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a>, then set the necessary parameters with FLAC__stream_encoder_set_*(), and initialize it by calling one of the FLAC__stream_encoder_init_*() functions.</p>
<p>Unlike the decoders, the stream encoder has many options that can affect the speed and compression ratio. When setting these parameters you should have some basic knowledge of the format (see the <a href="https://xiph.org/flac/documentation_format_overview.html">user-level documentation</a> or the <a href="https://xiph.org/flac/format.html">formal description</a>). The FLAC__stream_encoder_set_*() functions themselves do not validate the values as many are interdependent. The FLAC__stream_encoder_init_*() functions will do this, so make sure to pay attention to the state returned by FLAC__stream_encoder_init_*() to make sure that it is FLAC__STREAM_ENCODER_INIT_STATUS_OK. Any parameters that are not set before FLAC__stream_encoder_init_*() will take on the defaults from the constructor.</p>
<p>There are three initialization functions for native FLAC, one for setting up the encoder to encode FLAC data to the client via callbacks, and two for encoding directly to a file.</p>
<p>For encoding via callbacks, use <a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a>. You must also supply a write callback which will be called anytime there is raw encoded data to write. If the client can seek the output it is best to also supply seek and tell callbacks, as this allows the encoder to go back after encoding is finished to write back information that was collected while encoding, like seek point offsets, frame sizes, etc.</p>
<p>For encoding directly to a file, use <a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE()</a> or <a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file()</a>. Then you must only supply a filename or open <code>FILE*</code>; the encoder will handle all the callbacks internally. You may also supply a progress callback for periodic notification of the encoding progress.</p>
<p>There are three similarly-named init functions for encoding to Ogg FLAC streams. Check <code>FLAC_API_SUPPORTS_OGG_FLAC</code> to find out if the library has been built with Ogg support.</p>
<p>The call to FLAC__stream_encoder_init_*() currently will also immediately call the write callback several times, once with the <code>fLaC</code> signature, and once for each encoded metadata block. Note that for Ogg FLAC encoding you will usually get at least twice the number of callbacks than with native FLAC, one for the Ogg page header and one for the page body.</p>
<p>After initializing the instance, the client may feed audio data to the encoder in one of two ways:</p>
<ul>
<li>Channel separate, through <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> - The client will pass an array of pointers to buffers, one for each channel, to the encoder, each of the same length. The samples need not be block-aligned, but each channel should have the same number of samples.</li>
<li>Channel interleaved, through <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a> - The client will pass a single pointer to data that is channel-interleaved (i.e. channel0_sample0, channel1_sample0, ... , channelN_sample0, channel0_sample1, ...). Again, the samples need not be block-aligned but they must be sample-aligned, i.e. the first value should be channel0_sample0 and the last value channelN_sampleM.</li>
</ul>
<p>Note that for either process call, each sample in the buffers should be a signed integer, right-justified to the resolution set by <a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a>. For example, if the resolution is 16 bits per sample, the samples should all be in the range [-32768,32767].</p>
<p>When the client is finished encoding data, it calls <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>, which causes the encoder to encode any data still in its input pipe, and call the metadata callback with the final encoding statistics. Then the instance may be deleted with <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a> or initialized again to encode another stream.</p>
<p>For programs that write their own metadata, but that do not know the actual metadata until after encoding, it is advantageous to instruct the encoder to write a PADDING block of the correct size, so that instead of rewriting the whole stream after encoding, the program can just overwrite the PADDING block. If only the maximum size of the metadata is known, the program can write a slightly larger padding block, then split it after encoding.</p>
<p>Make sure you understand how lengths are calculated. All FLAC metadata blocks have a 4 byte header which contains the type and length. This length does not include the 4 bytes of the header. See the format page for the specification of metadata blocks and their lengths.</p>
<dl class="section note"><dt>Note</dt><dd>If you are writing the FLAC data to a file via callbacks, make sure it is open for update (e.g. mode "w+" for stdio streams). This is because after the first encoding pass, the encoder will try to seek back to the beginning of the stream, to the STREAMINFO block, to write some data there. (If using FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE(), the file is managed internally.)</dd>
<dd>
The "set" functions may only be called when the encoder is in the state FLAC__STREAM_ENCODER_UNINITIALIZED, i.e. after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> or <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>, but before FLAC__stream_encoder_init_*(). If this is the case they will return <code>true</code>, otherwise <code>false</code>.</dd>
<dd>
<a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> resets all settings to the constructor defaults. </dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga18b7941b93bae067192732e913536d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18b7941b93bae067192732e913536d44">&#9670;&nbsp;</a></span>FLAC__StreamEncoderReadCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a>(* FLAC__StreamEncoderReadCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Signature for the read callback.</p>
<p>A function pointer matching this signature must be passed to <a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> if seeking is supported. The supplied function will be called when the encoder needs to read back encoded data. This happens during the metadata callback, when the encoder has to read, modify, and rewrite the metadata (e.g. seekpoints) gathered while encoding. The address of the buffer to be filled is supplied, along with the number of bytes the buffer can hold. The callback may choose to supply less data and modify the byte count but must be careful not to overflow the buffer. The callback then returns a status code chosen from FLAC__StreamEncoderReadStatus.</p>
<p>Here is an example of a read callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a> read_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__byte buffer[], <span class="keywordtype">size_t</span> *bytes, <span class="keywordtype">void</span> *client_data)</div>
<div class="line">{</div>
<div class="line">  FILE *file = ((MyClientData*)client_data)-&gt;file;</div>
<div class="line">  <span class="keywordflow">if</span>(*bytes &gt; 0) {</div>
<div class="line">    *bytes = fread(buffer, <span class="keyword">sizeof</span>(FLAC__byte), *bytes, file);</div>
<div class="line">    <span class="keywordflow">if</span>(ferror(file))</div>
<div class="line">      <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_READ_STATUS_ABORT</a>;</div>
<div class="line">    <span class="keywordflow">else</span> <span class="keywordflow">if</span>(*bytes == 0)</div>
<div class="line">      <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee">FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM</a>;</div>
<div class="line">    <span class="keywordflow">else</span></div>
<div class="line">      <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e">FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE</a>;</div>
<div class="line">  }</div>
<div class="line">  <span class="keywordflow">else</span></div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_READ_STATUS_ABORT</a>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ga2e81f007fb0a7414c0bbb453f37ea37f"><div class="ttname"><a href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a></div><div class="ttdeci">FLAC__StreamEncoderReadStatus</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:362</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e"><div class="ttname"><a href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e">FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:364</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee"><div class="ttname"><a href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee">FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:367</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759"><div class="ttname"><a href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_READ_STATUS_ABORT</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_READ_STATUS_ABORT</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:370</div></div>
<div class="ttc" id="astructFLAC____StreamEncoder_html"><div class="ttname"><a href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a></div><div class="ttdef"><b>Definition:</b> stream_encoder.h:464</div></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
    <tr><td class="paramname">buffer</td><td>A pointer to a location for the callee to store data to be encoded. </td></tr>
    <tr><td class="paramname">bytes</td><td>A pointer to the size of the buffer. On entry to the callback, it contains the maximum number of bytes that may be stored in <em>buffer</em>. The callee must set it to the actual number of bytes stored (0 in case of error or end-of-stream) before returning. </td></tr>
    <tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_set_client_data(). </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderReadStatus</td><td>The callee's return status. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2998a0af774d793928a7cc3bbc84dcdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2998a0af774d793928a7cc3bbc84dcdf">&#9670;&nbsp;</a></span>FLAC__StreamEncoderWriteCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a>(* FLAC__StreamEncoderWriteCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Signature for the write callback.</p>
<p>A function pointer matching this signature must be passed to FLAC__stream_encoder_init*_stream(). The supplied function will be called by the encoder anytime there is raw encoded data ready to write. It may include metadata mixed with encoded audio frames and the data is not guaranteed to be aligned on frame or metadata block boundaries.</p>
<p>The only duty of the callback is to write out the <em>bytes</em> worth of data in <em>buffer</em> to the current position in the output stream. The arguments <em>samples</em> and <em>current_frame</em> are purely informational. If <em>samples</em> is greater than <code>0</code>, then <em>current_frame</em> will hold the current frame number that is being written; otherwise it indicates that the write callback is being called to write metadata.</p>
<dl class="section note"><dt>Note</dt><dd>Unlike when writing to native FLAC, when writing to Ogg FLAC the write callback will be called twice when writing each audio frame; once for the page header, and once for the page body. When writing the page header, the <em>samples</em> argument to the write callback will be <code>0</code>.</dd>
<dd>
In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
    <tr><td class="paramname">buffer</td><td>An array of encoded data of length <em>bytes</em>. </td></tr>
    <tr><td class="paramname">bytes</td><td>The byte length of <em>buffer</em>. </td></tr>
    <tr><td class="paramname">samples</td><td>The number of samples encoded by <em>buffer</em>. <code>0</code> has a special meaning; see above. </td></tr>
    <tr><td class="paramname">current_frame</td><td>The number of the current frame being encoded. </td></tr>
    <tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderWriteStatus</td><td>The callee's return status. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga70b85349d5242e4401c4d8ddf6d9bbca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70b85349d5242e4401c4d8ddf6d9bbca">&#9670;&nbsp;</a></span>FLAC__StreamEncoderSeekCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a>(* FLAC__StreamEncoderSeekCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Signature for the seek callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_encoder_init*_stream(). The supplied function will be called when the encoder needs to seek the output stream. The encoder will pass the absolute byte offset to seek to, 0 meaning the beginning of the stream.</p>
<p>Here is an example of a seek callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a> seek_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, <span class="keywordtype">void</span> *client_data)</div>
<div class="line">{</div>
<div class="line">  FILE *file = ((MyClientData*)client_data)-&gt;file;</div>
<div class="line">  <span class="keywordflow">if</span>(file == stdin)</div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037">FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</a>;</div>
<div class="line">  <span class="keywordflow">else</span> <span class="keywordflow">if</span>(fseeko(file, (off_t)absolute_byte_offset, SEEK_SET) &lt; 0)</div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60">FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR</a>;</div>
<div class="line">  <span class="keywordflow">else</span></div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667">FLAC__STREAM_ENCODER_SEEK_STATUS_OK</a>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ga6d5be3489f45fcf0c252022c65d87aca"><div class="ttname"><a href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a></div><div class="ttdeci">FLAC__StreamEncoderSeekStatus</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:408</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037"><div class="ttname"><a href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037">FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:416</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667"><div class="ttname"><a href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667">FLAC__STREAM_ENCODER_SEEK_STATUS_OK</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_SEEK_STATUS_OK</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:410</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60"><div class="ttname"><a href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60">FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:413</div></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
    <tr><td class="paramname">absolute_byte_offset</td><td>The offset from the beginning of the stream to seek to. </td></tr>
    <tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderSeekStatus</td><td>The callee's return status. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gabefdf2279e1d0347d9f98f46da4e415b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabefdf2279e1d0347d9f98f46da4e415b">&#9670;&nbsp;</a></span>FLAC__StreamEncoderTellCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a>(* FLAC__StreamEncoderTellCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Signature for the tell callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_encoder_init*_stream(). The supplied function will be called when the encoder needs to know the current position of the output stream.</p>
<dl class="section warning"><dt>Warning</dt><dd>The callback must return the true current byte offset of the output to which the encoder is writing. If you are buffering the output, make sure and take this into account. If you are writing directly to a FILE* from your write callback, ftell() is sufficient. If you are writing directly to a file descriptor from your write callback, you can use lseek(fd, SEEK_CUR, 0). The encoder may later seek back to these points to rewrite metadata after encoding.</dd></dl>
<p>Here is an example of a tell callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a> tell_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, <span class="keywordtype">void</span> *client_data)</div>
<div class="line">{</div>
<div class="line">  FILE *file = ((MyClientData*)client_data)-&gt;file;</div>
<div class="line">  off_t pos;</div>
<div class="line">  <span class="keywordflow">if</span>(file == stdin)</div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7">FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</a>;</div>
<div class="line">  <span class="keywordflow">else</span> <span class="keywordflow">if</span>((pos = ftello(file)) &lt; 0)</div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b">FLAC__STREAM_ENCODER_TELL_STATUS_ERROR</a>;</div>
<div class="line">  <span class="keywordflow">else</span> {</div>
<div class="line">    *absolute_byte_offset = (FLAC__uint64)pos;</div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b">FLAC__STREAM_ENCODER_TELL_STATUS_OK</a>;</div>
<div class="line">  }</div>
<div class="line">}</div>
<div class="ttc" id="agroup__flac__stream__encoder_html_gab628f63181250eb977a28bf12b7dd9ff"><div class="ttname"><a href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a></div><div class="ttdeci">FLAC__StreamEncoderTellStatus</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:431</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b"><div class="ttname"><a href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b">FLAC__STREAM_ENCODER_TELL_STATUS_OK</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_TELL_STATUS_OK</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:433</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7"><div class="ttname"><a href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7">FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:439</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b"><div class="ttname"><a href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b">FLAC__STREAM_ENCODER_TELL_STATUS_ERROR</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_TELL_STATUS_ERROR</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:436</div></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
    <tr><td class="paramname">absolute_byte_offset</td><td>The address at which to store the current position of the output. </td></tr>
    <tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderTellStatus</td><td>The callee's return status. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga091fbf3340d85bcbda1090c31bc320cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga091fbf3340d85bcbda1090c31bc320cf">&#9670;&nbsp;</a></span>FLAC__StreamEncoderMetadataCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* FLAC__StreamEncoderMetadataCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Signature for the metadata callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_encoder_init*_stream(). The supplied function will be called once at the end of encoding with the populated STREAMINFO structure. This is so the client can seek back to the beginning of the file and write the STREAMINFO block with the correct statistics after encoding (like minimum/maximum frame size and total samples).</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
    <tr><td class="paramname">metadata</td><td>The final populated STREAMINFO block. </td></tr>
    <tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga42a5fab5f91c1b0c3f7098499285f277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42a5fab5f91c1b0c3f7098499285f277">&#9670;&nbsp;</a></span>FLAC__StreamEncoderProgressCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* FLAC__StreamEncoderProgressCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Signature for the progress callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE(). The supplied function will be called when the encoder has finished writing a frame. The <code>total_frames_estimate</code> argument to the callback will be based on the value from <a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate()</a>.</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
    <tr><td class="paramname">bytes_written</td><td>Bytes written so far. </td></tr>
    <tr><td class="paramname">samples_written</td><td>Samples written so far. </td></tr>
    <tr><td class="paramname">frames_written</td><td>Frames written so far. </td></tr>
    <tr><td class="paramname">total_frames_estimate</td><td>The estimate of the total number of frames to be written. </td></tr>
    <tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gac5e9db4fc32ca2fa74abd9c8a87c02a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5e9db4fc32ca2fa74abd9c8a87c02a5">&#9670;&nbsp;</a></span>FLAC__StreamEncoderState</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>State values for a <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>.</p>
<p>The encoder's state can be obtained by calling <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a>.</p>
<p>If the encoder gets into any other state besides <code>FLAC__STREAM_ENCODER_OK</code> or <code>FLAC__STREAM_ENCODER_UNINITIALIZED</code>, it becomes invalid for encoding and must be deleted with <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6"></a>FLAC__STREAM_ENCODER_OK&#160;</td><td class="fielddoc"><p>The encoder is in the normal OK state and samples can be processed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a04912e04a3c57d3c53de34742f96d635"></a>FLAC__STREAM_ENCODER_UNINITIALIZED&#160;</td><td class="fielddoc"><p>The encoder is in the uninitialized state; one of the FLAC__stream_encoder_init_*() functions must be called before samples can be processed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5abb312cc8318c7a541cadacd23ceb3bbb"></a>FLAC__STREAM_ENCODER_OGG_ERROR&#160;</td><td class="fielddoc"><p>An error occurred in the underlying Ogg layer. <br  />
 </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a4cb80be4f83eb71f04e74968af1d259e"></a>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR&#160;</td><td class="fielddoc"><p>An error occurred in the underlying verify stream decoder; check <a class="el" href="group__flac__stream__encoder.html#ga820704b95a711e77d55363e8753f9f9f">FLAC__stream_encoder_get_verify_decoder_state()</a>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a011e3d8b2d02a940bfd0e59c05cf5ae0"></a>FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA&#160;</td><td class="fielddoc"><p>The verify decoder detected a mismatch between the original audio signal and the decoded audio signal. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a8c2b2e9efb43a4f9b25b1d2bd9af5f23"></a>FLAC__STREAM_ENCODER_CLIENT_ERROR&#160;</td><td class="fielddoc"><p>One of the callbacks returned a fatal error. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5af0e4738522e05a7248435c7148f58f91"></a>FLAC__STREAM_ENCODER_IO_ERROR&#160;</td><td class="fielddoc"><p>An I/O error occurred while opening/reading/writing a file. Check <code>errno</code>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a2c2937b7f1600a4ac7c84fc70ab34cf1"></a>FLAC__STREAM_ENCODER_FRAMING_ERROR&#160;</td><td class="fielddoc"><p>An error occurred while writing the stream; usually, the write_callback returned an error. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a35db99d9958bd6c2301a04715fbc44fd"></a>FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR&#160;</td><td class="fielddoc"><p>Memory allocation failed. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga3bb869620af2b188d77982a5c30b047d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3bb869620af2b188d77982a5c30b047d">&#9670;&nbsp;</a></span>FLAC__StreamEncoderInitStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Possible return values for the FLAC__stream_encoder_init_*() functions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da20501dce552da74c5df935eeaa0c9ee3"></a>FLAC__STREAM_ENCODER_INIT_STATUS_OK&#160;</td><td class="fielddoc"><p>Initialization was successful. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da9c64e5f9020d8799e1cd9d39d50e6955"></a>FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR&#160;</td><td class="fielddoc"><p>General failure to set up encoder; call <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a> for cause. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da8a822b011de88b67c114505ffef39327"></a>FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER&#160;</td><td class="fielddoc"><p>The library was not compiled with support for the given container format. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047dac2cf461f02e20513003b8cadeae03f9f"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS&#160;</td><td class="fielddoc"><p>A required callback was not supplied. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da0541c4f827f081b9f1c54c9441e4aa65"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS&#160;</td><td class="fielddoc"><p>The encoder has an invalid setting for number of channels. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047dad6d2631f464183c0c165155200882e6b"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE&#160;</td><td class="fielddoc"><p>The encoder has an invalid setting for bits-per-sample. FLAC supports 4-32 bps. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da6fdcde9e18c37450c79e8f12b9d9c134"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE&#160;</td><td class="fielddoc"><p>The encoder has an invalid setting for the input sample rate. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da652c445f1bd8b6cfb963a30bf416c95a"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE&#160;</td><td class="fielddoc"><p>The encoder has an invalid setting for the block size. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da38a69e94b3333e4ba779d2ff8f43f64e"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER&#160;</td><td class="fielddoc"><p>The encoder has an invalid setting for the maximum LPC order. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da5be80403bd7a43450139442e0f34ad7e"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION&#160;</td><td class="fielddoc"><p>The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da62a17a3ed3c05ddf8ea7f6fecbd4e4a1"></a>FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER&#160;</td><td class="fielddoc"><p>The specified block size is less than the maximum LPC order. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047daa793405c858c7606539082750080a47e"></a>FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE&#160;</td><td class="fielddoc"><p>The encoder is bound to the <a href="https://xiph.org/flac/format.html#subset">Subset</a> but other settings violate it. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047daa85afdd1849c75a19594416cef63e3e9"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA&#160;</td><td class="fielddoc"><p>The metadata input to the encoder is invalid, in one of the following ways:</p><ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga80d57f9069e354cbf1a15a3e3ad9ca78">FLAC__stream_encoder_set_metadata()</a> was called with a null pointer but a block count &gt; 0</li>
<li>One of the metadata blocks contains an undefined type</li>
<li>It contains an illegal CUESHEET as checked by <a class="el" href="group__flac__format.html#gaa9ed0fa4ed04dbfdaa163d0f5308c080">FLAC__format_cuesheet_is_legal()</a></li>
<li>It contains an illegal SEEKTABLE as checked by <a class="el" href="group__flac__format.html#ga02ed0843553fb8f718fe8e7c54d12244">FLAC__format_seektable_is_legal()</a></li>
<li>It contains more than one SEEKTABLE block or more than one VORBIS_COMMENT block </li>
</ul>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047dab4e7b50d176a127575df90383cb15e1d"></a>FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED&#160;</td><td class="fielddoc"><p>FLAC__stream_encoder_init_*() was called when the encoder was already initialized, usually because <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> was not called. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga2e81f007fb0a7414c0bbb453f37ea37f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e81f007fb0a7414c0bbb453f37ea37f">&#9670;&nbsp;</a></span>FLAC__StreamEncoderReadStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> read callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e"></a>FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE&#160;</td><td class="fielddoc"><p>The read was OK and decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee"></a>FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM&#160;</td><td class="fielddoc"><p>The read was attempted at the end of the stream. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759"></a>FLAC__STREAM_ENCODER_READ_STATUS_ABORT&#160;</td><td class="fielddoc"><p>An unrecoverable error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa9bb730b8f6354cc1e810017a2f700316"></a>FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED&#160;</td><td class="fielddoc"><p>Client does not support reading back from the output. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga3737471fd49730bb8cf9b182bdeda05e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3737471fd49730bb8cf9b182bdeda05e">&#9670;&nbsp;</a></span>FLAC__StreamEncoderWriteStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> write callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3737471fd49730bb8cf9b182bdeda05ea5622e0199f0203c402fcb7b4ca76f808"></a>FLAC__STREAM_ENCODER_WRITE_STATUS_OK&#160;</td><td class="fielddoc"><p>The write was OK and encoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3737471fd49730bb8cf9b182bdeda05ea18e7cd6a443fb8bd303c3ba89946bc85"></a>FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR&#160;</td><td class="fielddoc"><p>An unrecoverable error occurred. The encoder will return from the process call. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga6d5be3489f45fcf0c252022c65d87aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d5be3489f45fcf0c252022c65d87aca">&#9670;&nbsp;</a></span>FLAC__StreamEncoderSeekStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> seek callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667"></a>FLAC__STREAM_ENCODER_SEEK_STATUS_OK&#160;</td><td class="fielddoc"><p>The seek was OK and encoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60"></a>FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR&#160;</td><td class="fielddoc"><p>An unrecoverable error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037"></a>FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED&#160;</td><td class="fielddoc"><p>Client does not support seeking. </p>
</td></tr>
</table>

</div>
</div>
<a id="gab628f63181250eb977a28bf12b7dd9ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab628f63181250eb977a28bf12b7dd9ff">&#9670;&nbsp;</a></span>FLAC__StreamEncoderTellStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> tell callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b"></a>FLAC__STREAM_ENCODER_TELL_STATUS_OK&#160;</td><td class="fielddoc"><p>The tell was OK and encoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b"></a>FLAC__STREAM_ENCODER_TELL_STATUS_ERROR&#160;</td><td class="fielddoc"><p>An unrecoverable error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7"></a>FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED&#160;</td><td class="fielddoc"><p>Client does not support seeking. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab09f7620a0ba9c30020c189ce112a52f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab09f7620a0ba9c30020c189ce112a52f">&#9670;&nbsp;</a></span>FLAC__stream_encoder_new()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>* FLAC__stream_encoder_new </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a new stream encoder instance. The instance is created with default settings; see the individual FLAC__stream_encoder_set_*() functions for each setting's default.</p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoder*</td><td><code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7212e6846f543618b6289666de216b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7212e6846f543618b6289666de216b29">&#9670;&nbsp;</a></span>FLAC__stream_encoder_delete()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FLAC__stream_encoder_delete </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Free an encoder instance. Deletes the object pointed to by <em>encoder</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>A pointer to an existing encoder. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>

</div>
</div>
<a id="gaf4f75f7689b6b3fff16b03028aa38326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf4f75f7689b6b3fff16b03028aa38326">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_ogg_serial_number()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_ogg_serial_number </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>serial_number</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the serial number for the FLAC stream to use in the Ogg container.</p>
<dl class="section note"><dt>Note</dt><dd>This does not need to be set for native FLAC encoding.</dd>
<dd>
It is recommended to set a serial number explicitly as the default of '0' may collide with other streams.</dd></dl>
<dl class="section user"><dt>Default Value: <code>0</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">serial_number</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga795be6527a9eb1219331afef2f182a41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga795be6527a9eb1219331afef2f182a41">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_verify()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_verify </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the "verify" flag. If <code>true</code>, the encoder will verify it's own encoded output by feeding it through an internal decoder and comparing the original signal against the decoded signal. If a mismatch occurs, the process call will return <code>false</code>. Note that this will slow the encoding process by the extra time required for decoding and comparison.</p>
<dl class="section user"><dt>Default Value: <code>false</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>Flag value (see above). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga35a18815a58141b88db02317892d059b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga35a18815a58141b88db02317892d059b">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_streamable_subset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_streamable_subset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the <a href="https://xiph.org/flac/format.html#subset">Subset</a> flag. If <code>true</code>, the encoder will comply with the Subset and will check the settings during FLAC__stream_encoder_init_*() to see if all settings comply. If <code>false</code>, the settings may take advantage of the full range that the format allows.</p>
<p>Make sure you know what it entails before setting this to <code>false</code>.</p>
<dl class="section user"><dt>Default Value: <code>true</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>Flag value (see above). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9ec612a48f81805eafdb059548cdaf92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ec612a48f81805eafdb059548cdaf92">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_channels()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_channels </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the number of channels to be encoded.</p>
<dl class="section user"><dt>Default Value: <code>2</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7453fc29d7e86b499f23b1adfba98da1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7453fc29d7e86b499f23b1adfba98da1">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_bits_per_sample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_bits_per_sample </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the sample resolution of the input to be encoded.</p>
<dl class="section warning"><dt>Warning</dt><dd>Do not feed the encoder data that is wider than the value you set here or you will generate an invalid stream.</dd></dl>
<dl class="section user"><dt>Default Value: <code>16</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa6b6537875900a6e0f4418a504f55f25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6b6537875900a6e0f4418a504f55f25">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_sample_rate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_sample_rate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the sample rate (in Hz) of the input to be encoded.</p>
<dl class="section user"><dt>Default Value: <code>44100</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaacc01aab02849119f929b8516420fcd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaacc01aab02849119f929b8516420fcd3">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_compression_level()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_compression_level </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the compression level</p>
<p>The compression level is roughly proportional to the amount of effort the encoder expends to compress the file. A higher level usually means more computation but higher compression. The default level is suitable for most applications.</p>
<p>Currently the levels range from <code>0</code> (fastest, least compression) to <code>8</code> (slowest, most compression). A value larger than <code>8</code> will be treated as <code>8</code>.</p>
<p>This function automatically calls the following other <code><em>set</em></code> functions with appropriate values, so the client does not need to unless it specifically wants to override them:</p><ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga3bff001a1efc2e4eb520c954066330f4">FLAC__stream_encoder_set_do_mid_side_stereo()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga7965d51b93f14cbd6ad5bb9d34f10536">FLAC__stream_encoder_set_loose_mid_side_stereo()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga6598f09ac782a1f2a5743ddf247c81c8">FLAC__stream_encoder_set_apodization()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gad8a0ff058c46f9ce95dc0508f4bdfb0c">FLAC__stream_encoder_set_max_lpc_order()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga179751f915a3d6fc2ca4b33a67bb8780">FLAC__stream_encoder_set_qlp_coeff_precision()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga495890067203958e5d67a641f8757b1c">FLAC__stream_encoder_set_do_qlp_coeff_prec_search()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gaed594c373d829f77808a935c54a25fa4">FLAC__stream_encoder_set_do_escape_coding()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga054313e7f6eaf5c6122d82c6a8b3b808">FLAC__stream_encoder_set_do_exhaustive_model_search()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga8f2ed5a2b35bfea13e6605b0fe55f0fa">FLAC__stream_encoder_set_min_residual_partition_order()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gab9e02bfbbb1d4fcdb666e2e9a678b4f6">FLAC__stream_encoder_set_max_residual_partition_order()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga2cc4a05caba8a4058f744d9eb8732caa">FLAC__stream_encoder_set_rice_parameter_search_dist()</a></li>
</ul>
<p>The actual values set for each level are: </p><table class="doxtable">
<tr>
<td><b>level</b> </td><td>do mid-side stereo </td><td>loose mid-side stereo </td><td>apodization </td><td>max lpc order </td><td>qlp coeff precision </td><td>qlp coeff prec search </td><td>escape coding </td><td>exhaustive model search </td><td>min residual partition order </td><td>max residual partition order </td><td>rice parameter search dist  </td></tr>
<tr>
<td><b>0</b> </td><td>false </td><td>false </td><td>tukey(0.5) </td><td>0 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>3 </td><td>0  </td></tr>
<tr>
<td><b>1</b> </td><td>true </td><td>true </td><td>tukey(0.5) </td><td>0 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>3 </td><td>0  </td></tr>
<tr>
<td><b>2</b> </td><td>true </td><td>false </td><td>tukey(0.5) </td><td>0 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>3 </td><td>0  </td></tr>
<tr>
<td><b>3</b> </td><td>false </td><td>false </td><td>tukey(0.5) </td><td>6 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>4 </td><td>0  </td></tr>
<tr>
<td><b>4</b> </td><td>true </td><td>true </td><td>tukey(0.5) </td><td>8 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>4 </td><td>0  </td></tr>
<tr>
<td><b>5</b> </td><td>true </td><td>false </td><td>tukey(0.5) </td><td>8 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>5 </td><td>0  </td></tr>
<tr>
<td><b>6</b> </td><td>true </td><td>false </td><td>subdivide_tukey(2) </td><td>8 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>6 </td><td>0  </td></tr>
<tr>
<td><b>7</b> </td><td>true </td><td>false </td><td>subdivide_tukey(2) </td><td>12 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>6 </td><td>0  </td></tr>
<tr>
<td><b>8</b> </td><td>true </td><td>false </td><td>subdivide_tukey(3) </td><td>12 </td><td>0 </td><td>false </td><td>false </td><td>false </td><td>0 </td><td>6 </td><td>0  </td></tr>
</table>
<dl class="section user"><dt>Default Value: <code>5</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gac35cb1b5614464658262e684c4ac3a2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac35cb1b5614464658262e684c4ac3a2f">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_blocksize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_blocksize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the blocksize to use while encoding.</p>
<p>The number of samples to use per frame. Use <code>0</code> to let the encoder estimate a blocksize; this is usually best.</p>
<dl class="section user"><dt>Default Value: <code>0</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga3bff001a1efc2e4eb520c954066330f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3bff001a1efc2e4eb520c954066330f4">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_do_mid_side_stereo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set to <code>true</code> to enable mid-side encoding on stereo input. The number of channels must be 2 for this to have any effect. Set to <code>false</code> to use only independent channel coding.</p>
<dl class="section user"><dt>Default Value: <code>true</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>Flag value (see above). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7965d51b93f14cbd6ad5bb9d34f10536"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7965d51b93f14cbd6ad5bb9d34f10536">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_loose_mid_side_stereo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set to <code>true</code> to enable adaptive switching between mid-side and left-right encoding on stereo input. Set to <code>false</code> to use exhaustive searching. Setting this to <code>true</code> requires <a class="el" href="group__flac__stream__encoder.html#ga3bff001a1efc2e4eb520c954066330f4">FLAC__stream_encoder_set_do_mid_side_stereo()</a> to also be set to <code>true</code> in order to have any effect.</p>
<dl class="section user"><dt>Default Value: <code>false</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>Flag value (see above). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6598f09ac782a1f2a5743ddf247c81c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6598f09ac782a1f2a5743ddf247c81c8">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_apodization()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_apodization </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>specification</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Sets the apodization function(s) the encoder will use when windowing audio data for LPC analysis.</p>
<p>The <em>specification</em> is a plain ASCII string which specifies exactly which functions to use. There may be more than one (up to 32), separated by <code>'</code>;' characters. Some functions take one or more comma-separated arguments in parentheses.</p>
<p>The available functions are <code>bartlett</code>, <code>bartlett_hann</code>, <code>blackman</code>, <code>blackman_harris_4term_92db</code>, <code>connes</code>, <code>flattop</code>, <code>gauss(STDDEV)</code>, <code>hamming</code>, <code>hann</code>, <code>kaiser_bessel</code>, <code>nuttall</code>, <code>rectangle</code>, <code>triangle</code>, <code>tukey(P)</code>, <code>partial_tukey</code>(n[/ov[/P]]), <code>punchout_tukey</code>(n[/ov[/P]]), <code>subdivide_tukey</code>(n[/P]), <code>welch</code>.</p>
<p>For <code>gauss(STDDEV)</code>, STDDEV specifies the standard deviation (0&lt;STDDEV&lt;=0.5).</p>
<p>For <code>tukey(P)</code>, P specifies the fraction of the window that is tapered (0&lt;=P&lt;=1). P=0 corresponds to <code>rectangle</code> and P=1 corresponds to <code>hann</code>.</p>
<p>Specifying <code>partial_tukey</code> or <code>punchout_tukey</code> works a little different. These do not specify a single apodization function, but a series of them with some overlap. partial_tukey specifies a series of small windows (all treated separately) while punchout_tukey specifies a series of windows that have a hole in them. In this way, the predictor is constructed with only a part of the block, which helps in case a block consists of dissimilar parts.</p>
<p>The three parameters that can be specified for the functions are n, ov and P. n is the number of functions to add, ov is the overlap of the windows in case of partial_tukey and the overlap in the gaps in case of punchout_tukey. P is the fraction of the window that is tapered, like with a regular tukey window. The function can be specified with only a number, a number and an overlap, or a number an overlap and a P, for example, partial_tukey(3), partial_tukey(3/0.3) and partial_tukey(3/0.3/0.5) are all valid. ov should be smaller than 1 and can be negative.</p>
<p>subdivide_tukey(n) is a more efficient reimplementation of partial_tukey and punchout_tukey taken together, recycling as much data as possible. It combines all possible non-redundant partial_tukey(n) and punchout_tukey(n) up to the n specified. Specifying subdivide_tukey(3) is equivalent to specifying tukey, partial_tukey(2), partial_tukey(3) and punchout_tukey(3), specifying subdivide_tukey(5) equivalently adds partial_tukey(4), punchout_tukey(4), partial_tukey(5) and punchout_tukey(5). To be able to reuse data as much as possible, the tukey taper is taken equal for all windows, and the P specified is applied for the smallest used window. In other words, subdivide_tukey(2/0.5) results in a taper equal to that of tukey(0.25) and subdivide_tukey(5) in a taper equal to that of tukey(0.1). The default P for subdivide_tukey when none is specified is 0.5.</p>
<p>Example specifications are <code>"blackman"</code> or <code>"hann;triangle;tukey(0.5);tukey(0.25);tukey(0.125)"</code> </p>
<p>Any function that is specified erroneously is silently dropped. Up to 32 functions are kept, the rest are dropped. If the specification is empty the encoder defaults to <code>"tukey(0.5)"</code>.</p>
<p>When more than one function is specified, then for every subframe the encoder will try each of them separately and choose the window that results in the smallest compressed subframe.</p>
<p>Note that each function specified causes the encoder to occupy a floating point array in which to store the window. Also note that the values of P, STDDEV and ov are locale-specific, so if the comma separator specified by the locale is a comma, a comma should be used. A locale-independent way is to specify using scientific notation, e.g. 5e-1 instad of 0.5 or 0,5.</p>
<dl class="section user"><dt>Default Value: <code>"tukey(0.5)"</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">specification</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> <div class="fragment"><div class="line">specification != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gad8a0ff058c46f9ce95dc0508f4bdfb0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad8a0ff058c46f9ce95dc0508f4bdfb0c">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_max_lpc_order()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_max_lpc_order </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the maximum LPC order, or <code>0</code> to use only the fixed predictors.</p>
<dl class="section user"><dt>Default Value: <code>8</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga179751f915a3d6fc2ca4b33a67bb8780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga179751f915a3d6fc2ca4b33a67bb8780">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_qlp_coeff_precision()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the precision, in bits, of the quantized linear predictor coefficients, or <code>0</code> to let the encoder select it based on the blocksize.</p>
<dl class="section user"><dt>Default Value: <code>0</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga495890067203958e5d67a641f8757b1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga495890067203958e5d67a641f8757b1c">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_do_qlp_coeff_prec_search()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set to <code>false</code> to use only the specified quantized linear predictor coefficient precision, or <code>true</code> to search neighboring precision values and use the best one.</p>
<dl class="section user"><dt>Default Value: <code>false</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaed594c373d829f77808a935c54a25fa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed594c373d829f77808a935c54a25fa4">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_do_escape_coding()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_do_escape_coding </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Deprecated. Setting this value has no effect.</p>
<dl class="section user"><dt>Default Value: <code>false</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga054313e7f6eaf5c6122d82c6a8b3b808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga054313e7f6eaf5c6122d82c6a8b3b808">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_do_exhaustive_model_search()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set to <code>false</code> to let the encoder estimate the best model order based on the residual signal energy, or <code>true</code> to force the encoder to evaluate all order models and select the best.</p>
<dl class="section user"><dt>Default Value: <code>false</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga8f2ed5a2b35bfea13e6605b0fe55f0fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8f2ed5a2b35bfea13e6605b0fe55f0fa">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_min_residual_partition_order()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the minimum partition order to search when coding the residual. This is used in tandem with <a class="el" href="group__flac__stream__encoder.html#gab9e02bfbbb1d4fcdb666e2e9a678b4f6">FLAC__stream_encoder_set_max_residual_partition_order()</a>.</p>
<p>The partition order determines the context size in the residual. The context size will be approximately <code>blocksize / (2 ^ order)</code>.</p>
<p>Set both min and max values to <code>0</code> to force a single context, whose Rice parameter is based on the residual signal variance. Otherwise, set a min and max order, and the encoder will search all orders, using the mean of each context for its Rice parameter, and use the best.</p>
<dl class="section user"><dt>Default Value: <code>0</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab9e02bfbbb1d4fcdb666e2e9a678b4f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab9e02bfbbb1d4fcdb666e2e9a678b4f6">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_max_residual_partition_order()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the maximum partition order to search when coding the residual. This is used in tandem with <a class="el" href="group__flac__stream__encoder.html#ga8f2ed5a2b35bfea13e6605b0fe55f0fa">FLAC__stream_encoder_set_min_residual_partition_order()</a>.</p>
<p>The partition order determines the context size in the residual. The context size will be approximately <code>blocksize / (2 ^ order)</code>.</p>
<p>Set both min and max values to <code>0</code> to force a single context, whose Rice parameter is based on the residual signal variance. Otherwise, set a min and max order, and the encoder will search all orders, using the mean of each context for its Rice parameter, and use the best.</p>
<dl class="section user"><dt>Default Value: <code>5</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2cc4a05caba8a4058f744d9eb8732caa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2cc4a05caba8a4058f744d9eb8732caa">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_rice_parameter_search_dist()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Deprecated. Setting this value has no effect.</p>
<dl class="section user"><dt>Default Value: <code>0</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab943094585d1c0a4bec497e73567cf85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab943094585d1c0a4bec497e73567cf85">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_total_samples_estimate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_total_samples_estimate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__uint64&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set an estimate of the total samples that will be encoded. This is merely an estimate and may be set to <code>0</code> if unknown. This value will be written to the STREAMINFO block before encoding, and can remove the need for the caller to rewrite the value later if the value is known before encoding.</p>
<dl class="section user"><dt>Default Value: <code>0</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga80d57f9069e354cbf1a15a3e3ad9ca78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80d57f9069e354cbf1a15a3e3ad9ca78">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_metadata()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_metadata </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **&#160;</td>
          <td class="paramname"><em>metadata</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>num_blocks</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the metadata blocks to be emitted to the stream before encoding. A value of <code>NULL</code>, <code>0</code> implies no metadata; otherwise, supply an array of pointers to metadata blocks. The array is non-const since the encoder may need to change the <em>is_last</em> flag inside them, and in some cases update seek point offsets. Otherwise, the encoder will not modify or free the blocks. It is up to the caller to free the metadata blocks after encoding finishes.</p>
<dl class="section note"><dt>Note</dt><dd>The encoder stores only copies of the pointers in the <em>metadata</em> array; the metadata blocks themselves must survive at least until after <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> returns. Do not free the blocks until then.</dd>
<dd>
The STREAMINFO block is always written and no STREAMINFO block may occur in the supplied array.</dd>
<dd>
By default the encoder does not create a SEEKTABLE. If one is supplied in the <em>metadata</em> array, but the client has specified that it does not support seeking, then the SEEKTABLE will be written verbatim. However by itself this is not very useful as the client will not know the stream offsets for the seekpoints ahead of time. In order to get a proper seektable the client must support seeking. See next note.</dd>
<dd>
SEEKTABLE blocks are handled specially. Since you will not know the values for the seek point stream offsets, you should pass in a SEEKTABLE 'template', that is, a SEEKTABLE object with the required sample numbers (or placeholder points), with <code>0</code> for the <em>frame_samples</em> and <em>stream_offset</em> fields for each point. If the client has specified that it supports seeking by providing a seek callback to <a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a> or both seek AND read callback to <a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> (or by using FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE()), then while it is encoding the encoder will fill the stream offsets in for you and when encoding is finished, it will seek back and write the real values into the SEEKTABLE block in the stream. There are helper routines for manipulating seektable template blocks; see metadata.h: FLAC__metadata_object_seektable_template_*(). If the client does not support seeking, the SEEKTABLE will have inaccurate offsets which will slow down or remove the ability to seek in the FLAC stream.</dd>
<dd>
The encoder instance <b>will</b> modify the first <code>SEEKTABLE</code> block as it transforms the template to a valid seektable while encoding, but it is still up to the caller to free all metadata blocks after encoding.</dd>
<dd>
A VORBIS_COMMENT block may be supplied. The vendor string in it will be ignored. libFLAC will use it's own vendor string. libFLAC will not modify the passed-in VORBIS_COMMENT's vendor string, it will simply write it's own into the stream. If no VORBIS_COMMENT block is present in the <em>metadata</em> array, libFLAC will write an empty one, containing only the vendor string.</dd>
<dd>
The Ogg FLAC mapping requires that the VORBIS_COMMENT block be the second metadata block of the stream. The encoder already supplies the STREAMINFO block automatically. If <em>metadata</em> does not contain a VORBIS_COMMENT block, the encoder will supply that too. Otherwise, if <em>metadata</em> does contain a VORBIS_COMMENT block and it is not the first, the init function will reorder <em>metadata</em> by moving the VORBIS_COMMENT block to the front; the relative ordering of the other blocks will remain as they were.</dd>
<dd>
The Ogg FLAC mapping limits the number of metadata blocks per stream to <code>65535</code>. If <em>num_blocks</em> exceeds this the function will return <code>false</code>.</dd></dl>
<dl class="section user"><dt>Default Value: <code>NULL</code>, 0</dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">metadata</td><td>See above. </td></tr>
    <tr><td class="paramname">num_blocks</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. <code>false</code> if the encoder is already initialized, or if <em>num_blocks</em> &gt; 65535 if encoding to Ogg FLAC, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gac8c5f361b441d528b7a6791b66bb9d40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8c5f361b441d528b7a6791b66bb9d40">&#9670;&nbsp;</a></span>FLAC__stream_encoder_set_limit_min_bitrate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_set_limit_min_bitrate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__bool&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set to <code>true</code> to make the encoder not output frames which contain only constant subframes. This is beneficial for streaming applications: very small frames can cause problems with buffering as bitrates can drop as low 1kbit/s for CDDA audio encoded within subset. The minimum bitrate for a FLAC file encoded with this function used is raised to 1bit/sample (i.e. 48kbit/s for 48kHz material).</p>
<dl class="section user"><dt>Default Value: <code>false</code> </dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
    <tr><td class="paramname">value</td><td>Flag value (see above). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga0803321b37189dc5eea4fe1cea25c29a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0803321b37189dc5eea4fe1cea25c29a">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_state()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a> FLAC__stream_encoder_get_state </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the current encoder state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderState</td><td>The current encoder state. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga820704b95a711e77d55363e8753f9f9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga820704b95a711e77d55363e8753f9f9f">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_verify_decoder_state()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__decoder.html#ga3adb6891c5871a87cd5bbae6c770ba2d">FLAC__StreamDecoderState</a> FLAC__stream_encoder_get_verify_decoder_state </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the state of the verify stream decoder. Useful when the stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamDecoderState</td><td>The verify stream decoder state. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga0916f813358eb6f1e44148353acd4d42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0916f813358eb6f1e44148353acd4d42">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_resolved_state_string()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* FLAC__stream_encoder_get_resolved_state_string </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the current encoder state as a C string. This version automatically resolves <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code> by getting the verify decoder's state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>A encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">const</td><td>char * The encoder state as a C string. Do not modify the contents. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga28373aaf2c47336828d5672696c36662"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga28373aaf2c47336828d5672696c36662">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_verify_decoder_error_stats()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FLAC__stream_encoder_get_verify_decoder_error_stats </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__uint64 *&#160;</td>
          <td class="paramname"><em>absolute_sample</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>frame_number</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>channel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>sample</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__int32 *&#160;</td>
          <td class="paramname"><em>expected</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FLAC__int32 *&#160;</td>
          <td class="paramname"><em>got</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get relevant values about the nature of a verify decoder error. Useful when the stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>. The arguments should be addresses in which the stats will be returned, or NULL if value is not desired.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
    <tr><td class="paramname">absolute_sample</td><td>The absolute sample number of the mismatch. </td></tr>
    <tr><td class="paramname">frame_number</td><td>The number of the frame in which the mismatch occurred. </td></tr>
    <tr><td class="paramname">channel</td><td>The channel in which the mismatch occurred. </td></tr>
    <tr><td class="paramname">sample</td><td>The number of the sample (relative to the frame) in which the mismatch occurred. </td></tr>
    <tr><td class="paramname">expected</td><td>The expected value for the sample in question. </td></tr>
    <tr><td class="paramname">got</td><td>The actual value returned by the decoder. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>

</div>
</div>
<a id="ga9efc4964992e001bcec0a8eaedee8d60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9efc4964992e001bcec0a8eaedee8d60">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_verify()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_verify </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the "verify" flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga795be6527a9eb1219331afef2f182a41">FLAC__stream_encoder_set_verify()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga201e64032ea4298b2379c93652b28245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga201e64032ea4298b2379c93652b28245">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_streamable_subset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_streamable_subset </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the <a href="https://xiph.org/flac/format.html#subset">Subset</a> flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga35a18815a58141b88db02317892d059b">FLAC__stream_encoder_set_streamable_subset()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga412401503141dd42e37831140f78cfa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga412401503141dd42e37831140f78cfa1">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_channels()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_channels </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the number of input channels being processed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga9ec612a48f81805eafdb059548cdaf92">FLAC__stream_encoder_set_channels()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga169bbf662b2a2df017b93f663deadd1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga169bbf662b2a2df017b93f663deadd1d">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_bits_per_sample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_bits_per_sample </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the input sample resolution setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gae56f27536528f13375ffdd23fa9045f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae56f27536528f13375ffdd23fa9045f7">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_sample_rate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_sample_rate </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the input sample rate setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#gaa6b6537875900a6e0f4418a504f55f25">FLAC__stream_encoder_set_sample_rate()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaf8a9715b2d09a6876b8dc104bfd70cdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf8a9715b2d09a6876b8dc104bfd70cdc">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_blocksize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_blocksize </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the blocksize setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#gac35cb1b5614464658262e684c4ac3a2f">FLAC__stream_encoder_set_blocksize()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga32da1f89997ab94ce5d677fcd7e24d56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga32da1f89997ab94ce5d677fcd7e24d56">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_do_mid_side_stereo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the "mid/side stereo coding" flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga32da1f89997ab94ce5d677fcd7e24d56">FLAC__stream_encoder_get_do_mid_side_stereo()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga1455859cf3d233bd4dfff86af010f4fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1455859cf3d233bd4dfff86af010f4fa">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_loose_mid_side_stereo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the "adaptive mid/side switching" flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga7965d51b93f14cbd6ad5bb9d34f10536">FLAC__stream_encoder_set_loose_mid_side_stereo()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga5e1d1c9acd3d5a17106b51f0c0107567"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5e1d1c9acd3d5a17106b51f0c0107567">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_max_lpc_order()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_max_lpc_order </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the maximum LPC order setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#gad8a0ff058c46f9ce95dc0508f4bdfb0c">FLAC__stream_encoder_set_max_lpc_order()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga909830fb7f4a0a35710452df39c269a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga909830fb7f4a0a35710452df39c269a3">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_qlp_coeff_precision()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_qlp_coeff_precision </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the quantized linear predictor coefficient precision setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga179751f915a3d6fc2ca4b33a67bb8780">FLAC__stream_encoder_set_qlp_coeff_precision()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga65bee5a769d4c5fdc95b81c2fb95061c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65bee5a769d4c5fdc95b81c2fb95061c">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_do_qlp_coeff_prec_search()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the qlp coefficient precision search flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga495890067203958e5d67a641f8757b1c">FLAC__stream_encoder_set_do_qlp_coeff_prec_search()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga0c944049800991422c1bfb3b1c0567a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0c944049800991422c1bfb3b1c0567a5">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_do_escape_coding()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_do_escape_coding </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the "escape coding" flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#gaed594c373d829f77808a935c54a25fa4">FLAC__stream_encoder_set_do_escape_coding()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7bc8b32f58df5564db4b6114cb11042d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7bc8b32f58df5564db4b6114cb11042d">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_do_exhaustive_model_search()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the exhaustive model search flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga054313e7f6eaf5c6122d82c6a8b3b808">FLAC__stream_encoder_set_do_exhaustive_model_search()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga4fa722297092aeaebc9d9e743a327d14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4fa722297092aeaebc9d9e743a327d14">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_min_residual_partition_order()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_min_residual_partition_order </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the minimum residual partition order setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga8f2ed5a2b35bfea13e6605b0fe55f0fa">FLAC__stream_encoder_set_min_residual_partition_order()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6f5dfbfb5c6e569c4bae5555c9bf87e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f5dfbfb5c6e569c4bae5555c9bf87e6">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_max_residual_partition_order()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_max_residual_partition_order </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get maximum residual partition order setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#gab9e02bfbbb1d4fcdb666e2e9a678b4f6">FLAC__stream_encoder_set_max_residual_partition_order()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaca0e38f283b2772b92da7cb4495d909a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca0e38f283b2772b92da7cb4495d909a">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_rice_parameter_search_dist()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__stream_encoder_get_rice_parameter_search_dist </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the Rice parameter search distance setting.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">uint32_t</td><td>See <a class="el" href="group__flac__stream__encoder.html#ga2cc4a05caba8a4058f744d9eb8732caa">FLAC__stream_encoder_set_rice_parameter_search_dist()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa22d8935bd985b9cccf6592160ffc6f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa22d8935bd985b9cccf6592160ffc6f2">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_total_samples_estimate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__uint64 FLAC__stream_encoder_get_total_samples_estimate </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the previously set estimate of the total samples to be encoded. The encoder merely mimics back the value given to <a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate()</a> since it has no other way of knowing how many samples the client will encode.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__uint64</td><td>See <a class="el" href="group__flac__stream__encoder.html#gaa22d8935bd985b9cccf6592160ffc6f2">FLAC__stream_encoder_get_total_samples_estimate()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga741c26084d203ac24d16c875b5d902ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga741c26084d203ac24d16c875b5d902ac">&#9670;&nbsp;</a></span>FLAC__stream_encoder_get_limit_min_bitrate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_get_limit_min_bitrate </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the "limit_min_bitrate" flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An encoder instance to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td>See <a class="el" href="group__flac__stream__encoder.html#gac8c5f361b441d528b7a6791b66bb9d40">FLAC__stream_encoder_set_limit_min_bitrate()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7d801879812b48fcbc40f409800c453c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d801879812b48fcbc40f409800c453c">&#9670;&nbsp;</a></span>FLAC__stream_encoder_init_stream()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> FLAC__stream_encoder_init_stream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a>&#160;</td>
          <td class="paramname"><em>write_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a>&#160;</td>
          <td class="paramname"><em>seek_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a>&#160;</td>
          <td class="paramname"><em>tell_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a>&#160;</td>
          <td class="paramname"><em>metadata_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the encoder instance to encode native FLAC streams.</p>
<p>This flavor of initialization sets up the encoder to encode to a native FLAC stream. I/O is performed via callbacks to the client. For encoding to a plain file via filename or open <code>FILE*</code>, <a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file()</a> and <a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE()</a> provide a simpler interface.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> and FLAC__stream_encoder_set_*() but before <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a>. initialization succeeded.</p>
<p>The call to <a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a> currently will also immediately call the write callback several times, once with the <code>fLaC</code> signature, and once for each encoded metadata block.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
    <tr><td class="paramname">write_callback</td><td>See FLAC__StreamEncoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
    <tr><td class="paramname">seek_callback</td><td>See FLAC__StreamEncoderSeekCallback. This pointer may be <code>NULL</code> if seeking is not supported. The encoder uses seeking to go back and write some some stream statistics to the STREAMINFO block; this is recommended but not necessary to create a valid FLAC stream. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em> must also be supplied. Alternatively, a dummy seek callback that just returns <code>FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the encoder. </td></tr>
    <tr><td class="paramname">tell_callback</td><td>See FLAC__StreamEncoderTellCallback. This pointer may be <code>NULL</code> if seeking is not supported. If <em>seek_callback</em> is <code>NULL</code> then this argument will be ignored. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em> must also be supplied. Alternatively, a dummy tell callback that just returns <code>FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the encoder. </td></tr>
    <tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamEncoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. If the client provides a seek callback, this function is not necessary as the encoder will automatically seek back and update the STREAMINFO block. It may also be <code>NULL</code> if the client does not support seeking, since it will have no way of going back to update the STREAMINFO. However the client can still supply a callback if it would like to know the details from the STREAMINFO. </td></tr>
    <tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderInitStatus</td><td><code>FLAC__STREAM_ENCODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamEncoderInitStatus for the meanings of other return values. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9d1981bcd30b8db4d73b5466be5570f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d1981bcd30b8db4d73b5466be5570f5">&#9670;&nbsp;</a></span>FLAC__stream_encoder_init_ogg_stream()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> FLAC__stream_encoder_init_ogg_stream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga18b7941b93bae067192732e913536d44">FLAC__StreamEncoderReadCallback</a>&#160;</td>
          <td class="paramname"><em>read_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a>&#160;</td>
          <td class="paramname"><em>write_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a>&#160;</td>
          <td class="paramname"><em>seek_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a>&#160;</td>
          <td class="paramname"><em>tell_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a>&#160;</td>
          <td class="paramname"><em>metadata_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the encoder instance to encode Ogg FLAC streams.</p>
<p>This flavor of initialization sets up the encoder to encode to a FLAC stream in an Ogg container. I/O is performed via callbacks to the client. For encoding to a plain file via filename or open <code>FILE*</code>, <a class="el" href="group__flac__stream__encoder.html#ga4891de2f56045941ae222b61b0fd83a4">FLAC__stream_encoder_init_ogg_file()</a> and <a class="el" href="group__flac__stream__encoder.html#ga57fc668f50ffd99a93df326bfab5e2b1">FLAC__stream_encoder_init_ogg_FILE()</a> provide a simpler interface.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> and FLAC__stream_encoder_set_*() but before <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a>. initialization succeeded.</p>
<p>The call to <a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> currently will also immediately call the write callback several times to write the metadata packets.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
    <tr><td class="paramname">read_callback</td><td>See FLAC__StreamEncoderReadCallback. This pointer must not be <code>NULL</code> if <em>seek_callback</em> is non-NULL since they are both needed to be able to write data back to the Ogg FLAC stream in the post-encode phase. </td></tr>
    <tr><td class="paramname">write_callback</td><td>See FLAC__StreamEncoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
    <tr><td class="paramname">seek_callback</td><td>See FLAC__StreamEncoderSeekCallback. This pointer may be <code>NULL</code> if seeking is not supported. The encoder uses seeking to go back and write some some stream statistics to the STREAMINFO block; this is recommended but not necessary to create a valid FLAC stream. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em> must also be supplied. Alternatively, a dummy seek callback that just returns <code>FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the encoder. </td></tr>
    <tr><td class="paramname">tell_callback</td><td>See FLAC__StreamEncoderTellCallback. This pointer may be <code>NULL</code> if seeking is not supported. If <em>seek_callback</em> is <code>NULL</code> then this argument will be ignored. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em> must also be supplied. Alternatively, a dummy tell callback that just returns <code>FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the encoder. </td></tr>
    <tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamEncoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. If the client provides a seek callback, this function is not necessary as the encoder will automatically seek back and update the STREAMINFO block. It may also be <code>NULL</code> if the client does not support seeking, since it will have no way of going back to update the STREAMINFO. However the client can still supply a callback if it would like to know the details from the STREAMINFO. </td></tr>
    <tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderInitStatus</td><td><code>FLAC__STREAM_ENCODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamEncoderInitStatus for the meanings of other return values. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga12789a1c4a4e31cd2e7187259fe127f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga12789a1c4a4e31cd2e7187259fe127f8">&#9670;&nbsp;</a></span>FLAC__stream_encoder_init_FILE()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> FLAC__stream_encoder_init_FILE </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a>&#160;</td>
          <td class="paramname"><em>progress_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the encoder instance to encode native FLAC files.</p>
<p>This flavor of initialization sets up the encoder to encode to a plain native FLAC file. For non-stdio streams, you must use <a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a> and provide callbacks for the I/O.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> and FLAC__stream_encoder_set_*() but before <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a>. initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
    <tr><td class="paramname">file</td><td>An open file. The file should have been opened with mode <code>"w+b"</code> and rewound. The file becomes owned by the encoder and should not be manipulated by the client while encoding. Unless <em>file</em> is <code>stdout</code>, it will be closed when <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> is called. Note however that a proper SEEKTABLE cannot be created when encoding to <code>stdout</code> since it is not seekable. </td></tr>
    <tr><td class="paramname">progress_callback</td><td>See FLAC__StreamEncoderProgressCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
    <tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> <div class="fragment"><div class="line">file != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderInitStatus</td><td><code>FLAC__STREAM_ENCODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamEncoderInitStatus for the meanings of other return values. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga57fc668f50ffd99a93df326bfab5e2b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57fc668f50ffd99a93df326bfab5e2b1">&#9670;&nbsp;</a></span>FLAC__stream_encoder_init_ogg_FILE()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> FLAC__stream_encoder_init_ogg_FILE </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a>&#160;</td>
          <td class="paramname"><em>progress_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the encoder instance to encode Ogg FLAC files.</p>
<p>This flavor of initialization sets up the encoder to encode to a plain Ogg FLAC file. For non-stdio streams, you must use <a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> and provide callbacks for the I/O.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> and FLAC__stream_encoder_set_*() but before <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a>. initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
    <tr><td class="paramname">file</td><td>An open file. The file should have been opened with mode <code>"w+b"</code> and rewound. The file becomes owned by the encoder and should not be manipulated by the client while encoding. Unless <em>file</em> is <code>stdout</code>, it will be closed when <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> is called. Note however that a proper SEEKTABLE cannot be created when encoding to <code>stdout</code> since it is not seekable. </td></tr>
    <tr><td class="paramname">progress_callback</td><td>See FLAC__StreamEncoderProgressCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
    <tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> <div class="fragment"><div class="line">file != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderInitStatus</td><td><code>FLAC__STREAM_ENCODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamEncoderInitStatus for the meanings of other return values. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9d5117c2ac0eeb572784116bf2eb541b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d5117c2ac0eeb572784116bf2eb541b">&#9670;&nbsp;</a></span>FLAC__stream_encoder_init_file()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> FLAC__stream_encoder_init_file </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a>&#160;</td>
          <td class="paramname"><em>progress_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the encoder instance to encode native FLAC files.</p>
<p>This flavor of initialization sets up the encoder to encode to a plain FLAC file. If POSIX fopen() semantics are not sufficient you must use <a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE()</a>, or <a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a> and provide callbacks for the I/O.</p>
<p>On Windows, filename must be a UTF-8 encoded filename, which libFLAC internally translates to an appropriate representation to use with _wfopen. On all other systems, filename is passed to fopen without any translation.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> and FLAC__stream_encoder_set_*() but before <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a>. initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
    <tr><td class="paramname">filename</td><td>The name of the file to encode to. The file will be opened with fopen(). Use <code>NULL</code> to encode to <code>stdout</code>. Note however that a proper SEEKTABLE cannot be created when encoding to <code>stdout</code> since it is not seekable. </td></tr>
    <tr><td class="paramname">progress_callback</td><td>See FLAC__StreamEncoderProgressCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
    <tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderInitStatus</td><td><code>FLAC__STREAM_ENCODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamEncoderInitStatus for the meanings of other return values. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga4891de2f56045941ae222b61b0fd83a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4891de2f56045941ae222b61b0fd83a4">&#9670;&nbsp;</a></span>FLAC__stream_encoder_init_ogg_file()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> FLAC__stream_encoder_init_ogg_file </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a>&#160;</td>
          <td class="paramname"><em>progress_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the encoder instance to encode Ogg FLAC files.</p>
<p>This flavor of initialization sets up the encoder to encode to a plain Ogg FLAC file. If POSIX fopen() semantics are not sufficient, you must use <a class="el" href="group__flac__stream__encoder.html#ga57fc668f50ffd99a93df326bfab5e2b1">FLAC__stream_encoder_init_ogg_FILE()</a>, or <a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> and provide callbacks for the I/O.</p>
<p>On Windows, filename must be a UTF-8 encoded filename, which libFLAC internally translates to an appropriate representation to use with _wfopen. On all other systems, filename is passed to fopen without any translation.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> and FLAC__stream_encoder_set_*() but before <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a>. initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
    <tr><td class="paramname">filename</td><td>The name of the file to encode to. The file will be opened with fopen(). Use <code>NULL</code> to encode to <code>stdout</code>. Note however that a proper SEEKTABLE cannot be created when encoding to <code>stdout</code> since it is not seekable. </td></tr>
    <tr><td class="paramname">progress_callback</td><td>See FLAC__StreamEncoderProgressCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
    <tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__StreamEncoderInitStatus</td><td><code>FLAC__STREAM_ENCODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamEncoderInitStatus for the meanings of other return values. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga3522f9de5af29807df1b9780a418b7f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3522f9de5af29807df1b9780a418b7f3">&#9670;&nbsp;</a></span>FLAC__stream_encoder_finish()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Finish the encoding process. Flushes the encoding buffer, releases resources, resets the encoder settings to their defaults, and returns the encoder state to FLAC__STREAM_ENCODER_UNINITIALIZED. Note that this can generate one or more write callbacks before returning, and will generate a metadata callback.</p>
<p>Note that in the course of processing the last frame, errors can occur, so the caller should be sure to check the return value to ensure the file was encoded properly.</p>
<p>In the event of a prematurely-terminated encode, it is not strictly necessary to call this immediately before <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a> but it is good practice to match every FLAC__stream_encoder_init_*() with a <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An uninitialized encoder instance. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>false</code> if an error occurred processing the last frame; or if verify mode is set (see <a class="el" href="group__flac__stream__encoder.html#ga795be6527a9eb1219331afef2f182a41">FLAC__stream_encoder_set_verify()</a>), there was a verify mismatch; else <code>true</code>. If <code>false</code>, caller should check the state with <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a> for more information about the error. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga87b9c361292da5c5928a8fb5fda7c423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga87b9c361292da5c5928a8fb5fda7c423">&#9670;&nbsp;</a></span>FLAC__stream_encoder_process()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_process </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const FLAC__int32 *const&#160;</td>
          <td class="paramname"><em>buffer</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>samples</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Submit data for encoding. This version allows you to supply the input data via an array of pointers, each pointer pointing to an array of <em>samples</em> samples representing one channel. The samples need not be block-aligned, but each channel should have the same number of samples. Each sample should be a signed integer, right-justified to the resolution set by <a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a>. For example, if the resolution is 16 bits per sample, the samples should all be in the range [-32768,32767].</p>
<p>For applications where channel order is important, channels must follow the order as described in the <a href="https://xiph.org/flac/format.html#frame_header">frame header</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An initialized encoder instance in the OK state. </td></tr>
    <tr><td class="paramname">buffer</td><td>An array of pointers to each channel's signal. </td></tr>
    <tr><td class="paramname">samples</td><td>The number of samples in one channel. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> <div class="fragment"><div class="line"><a class="code" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state</a>(encoder) == <a class="code" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6">FLAC__STREAM_ENCODER_OK</a> </div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ga0803321b37189dc5eea4fe1cea25c29a"><div class="ttname"><a href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state</a></div><div class="ttdeci">FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder)</div></div>
<div class="ttc" id="agroup__flac__stream__encoder_html_ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6"><div class="ttname"><a href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6">FLAC__STREAM_ENCODER_OK</a></div><div class="ttdeci">@ FLAC__STREAM_ENCODER_OK</div><div class="ttdef"><b>Definition:</b> stream_encoder.h:243</div></div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a> to see what went wrong. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6e31c221f7e23345267c52f53c046c24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e31c221f7e23345267c52f53c046c24">&#9670;&nbsp;</a></span>FLAC__stream_encoder_process_interleaved()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__bool FLAC__stream_encoder_process_interleaved </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *&#160;</td>
          <td class="paramname"><em>encoder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const FLAC__int32&#160;</td>
          <td class="paramname"><em>buffer</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>samples</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Submit data for encoding. This version allows you to supply the input data where the channels are interleaved into a single array (i.e. channel0_sample0, channel1_sample0, ... , channelN_sample0, channel0_sample1, ...). The samples need not be block-aligned but they must be sample-aligned, i.e. the first value should be channel0_sample0 and the last value channelN_sampleM. Each sample should be a signed integer, right-justified to the resolution set by <a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a>. For example, if the resolution is 16 bits per sample, the samples should all be in the range [-32768,32767].</p>
<p>For applications where channel order is important, channels must follow the order as described in the <a href="https://xiph.org/flac/format.html#frame_header">frame header</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">encoder</td><td>An initialized encoder instance in the OK state. </td></tr>
    <tr><td class="paramname">buffer</td><td>An array of channel-interleaved data (see above). </td></tr>
    <tr><td class="paramname">samples</td><td>The number of samples in one channel, the same as for <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a>. For example, if encoding two channels, <code>1000</code> <em>samples</em> corresponds to a <em>buffer</em> of 2000 values. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div>
</div><!-- fragment --> <div class="fragment"><div class="line"><a class="code" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state</a>(encoder) == <a class="code" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6">FLAC__STREAM_ENCODER_OK</a> </div>
</div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">FLAC__bool</td><td><code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a> to see what went wrong. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga1410b7a076b0c8401682f9f812b66df5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1410b7a076b0c8401682f9f812b66df5">&#9670;&nbsp;</a></span>FLAC__StreamEncoderStateString</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* const FLAC__StreamEncoderStateString[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamEncoderState to a C string.</p>
<p>Using a FLAC__StreamEncoderState as the index to this array will give the string equivalent. The contents should not be modified. </p>

</div>
</div>
<a id="ga0ec1fa7b3f55b4f07a2727846c285776"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ec1fa7b3f55b4f07a2727846c285776">&#9670;&nbsp;</a></span>FLAC__StreamEncoderInitStatusString</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* const FLAC__StreamEncoderInitStatusString[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamEncoderInitStatus to a C string.</p>
<p>Using a FLAC__StreamEncoderInitStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>

</div>
</div>
<a id="ga1654422c81846b9b399ac5fb98df61dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1654422c81846b9b399ac5fb98df61dd">&#9670;&nbsp;</a></span>FLAC__StreamEncoderReadStatusString</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* const FLAC__StreamEncoderReadStatusString[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamEncoderReadStatus to a C string.</p>
<p>Using a FLAC__StreamEncoderReadStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>

</div>
</div>
<a id="ga9f64480accd01525cbfa25c11e6bb74e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f64480accd01525cbfa25c11e6bb74e">&#9670;&nbsp;</a></span>FLAC__StreamEncoderWriteStatusString</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* const FLAC__StreamEncoderWriteStatusString[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamEncoderWriteStatus to a C string.</p>
<p>Using a FLAC__StreamEncoderWriteStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>

</div>
</div>
<a id="gabb137b2d787756bf97398f0b60e54c20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb137b2d787756bf97398f0b60e54c20">&#9670;&nbsp;</a></span>FLAC__StreamEncoderSeekStatusString</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* const FLAC__StreamEncoderSeekStatusString[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamEncoderSeekStatus to a C string.</p>
<p>Using a FLAC__StreamEncoderSeekStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>

</div>
</div>
<a id="gaf8ab921ae968be2be255be1f136e1eec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf8ab921ae968be2be255be1f136e1eec">&#9670;&nbsp;</a></span>FLAC__StreamEncoderTellStatusString</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* const FLAC__StreamEncoderTellStatusString[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamEncoderTellStatus to a C string.</p>
<p>Using a FLAC__StreamEncoderTellStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>

</div>
</div>
</div><!-- contents -->

<hr size="1"/>
Copyright (c) 2000-2009  Josh Coalson
Copyright (c) 2011-2023  Xiph.Org Foundation
<!-- Copyright (c) 2000-2009  Josh Coalson -->
<!-- Copyright (c) 2011-2023  Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>
